Process
Description
Process is an entry in the General Plugin of Process Studio Processes. The 'Process' process entry refers to already existing processes. One or more process entries in a Process may perform different functional tasks. Hence, a process can be broken into smaller processes for the sake of organizational and visual simplicity.
Configurations
| No. | Field Name | Description |
|---|---|---|
| Process Specification Tab | ||
| 1 | Process Entry name | Specify a unique name for the process entry on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name. |
| 2 | Process filename | Specify your process by entering its path or clicking Browse. If you select a process that has the same root path as the current process, the variable ${Internal.Entry.Current.Directory} will automatically be inserted in place of the common root path. For example, if the current process' path is /home/admin/workflow.psp and you select a process in the folder /home/admin/path/sub.psp then the path will automatically be converted to ${Internal.Entry.Current.Directory}/path/sub.psp. The following two buttons in this section make it easier to work with the process: - New process: Click to create a new process, which will open in a new tab. - Edit process: Click to open the currently selected process in a new tab to modify the details. |
| 3 | Repository: specify by name | If you are working in the Process Studio (PS) Repository or database repository, specify the name of the workflow to start. Click the button to browse through the PS Repository. This feature is currently not enabled. |
| 4 | Repository: specify by reference | If you specify a workflow or process by reference, you can rename or move it around in the DI Repository. The reference (identifier) is stored, not the name and directory This feature is currently not enabled. |
| Advanced Tab | ||
| 1 | Copy previous results to args? | The results from a previous workflow can be copied as arguments of the process using the "Copy rows to result" step. If Execute for every input row is enabled then each row is a set of command line arguments to be passed into the process, otherwise only the first row is used to generate the command line arguments. |
| 2 | Copy previous results to parameters? | If Execute for every input row is enabled then each row is a set of command line process arguments to be passed into the process, otherwise only the first row is used to generate the command line arguments. |
| 3 | Execute for every input row? | Implements looping; if the previous process entry returns a set of result rows, the process executes once for every row found. One row is passed to the process at every execution. For example, you can execute a process each row in an excel sheet or for each file found in a directory. |
| 4 | Remote slave server | The slave server on which to execute the process. This feature is currently not enabled. |
| 5 | Pass process export to slave? | Pass the complete process (including referenced sub- process and sub-workflows) to the remote server. This feature is currently not enabled. |
| 6 | Wait for the remote process to finish? | Enable to block until the process on the slave server has finished executing. This feature is currently not enabled. |
| 7 | Follow local abort to remote process? | Enable to send the abort signal to the remote process if it is called locally. This feature is currently not enabled. |
| 8 | Expand child processes and workflow on the server | When the remote process starts child processes and workflows, they are exposed on the slave server and can be monitored. This feature is currently not enabled. |
| Logging settings Tab: | ||
| 1 | Specify logfile? | Select the checkbox to create a custom log file, in addition, to the default log file. |
| 2 | Append logfile? | Select the checkbox to append to the existing log file instead of creating a new file. |
| 3 | Name of logfile | Browse the file path and specify the file name. |
| 4 | Create parent folder | Create the parent folder for the log file if it does not already exists. |
| 5 | Extension of logfile | Specify the file name extension, for example, .log' or '.txt'. |
| 6 | Include date in logfile? | Select the checkbox to add the system date to the file name with the format 'YYYYMMDD', for example '_20051231'. |
| 7 | Include time in logfile? | Select the checkbox to add the system time to the file name with the format 'HHMMSS', for example, '_235959' |
| 8 | Loglevel | Select the type of log details you want. Available options are: - Nothing - Error - Minimal - Basic - Detailed - Debug - Row Level (very detailed) - Warning |
| Note | The custom log file is also available in the AE UI in the Requests page. | |
| Argument Tab | ||
| 1 | Arguments | Specify which command-line arguments that will be passed to the process. |
| Parameters Tab: | Enter the following information to pass parameters to the process: | |
| 1 | Pass all parameter values down to the sub- process | Enable check box to pass all parameters of the process down to the sub- process. |
| 2 | Parameter | Specify the parameter name passed to the process. |
| 3 | Stream Column Name | Specify the field of an incoming record from a previous process as the parameter. |
| 4 | Value | Specify a field value. To map a parent parameter to a child parameter: 1. Press Ctrl+Space to view the available parent parameters and variables. 2. Select the required variable, such as ${parent_param}. How parameter mapping works: - Non-credential parent parameter to a child parameter: The step passes the parameter's value. - Whole credential ( ${parent_cred}) to a child credential parameter: The step passes the full credential. - Credential sub-attribute ( ${parent_cred.Username}) to a child credential parameter: The system still passes the full credential. - Credential to a non-credential child parameter: The system displays a warning when selecting OK. Proceeding sends the credential as a JSON value Notes: - Credential parameters: Map an entire parent credential parameter to a child credential parameter. For example, select ${parent_cred} for the child's credential parameter. The step passes the complete credential object (username, password, and all other attributes) to the child. - Alternatively, select a single attribute of the parent credential, such as ${parent_cred.Username}. When the child parameter uses the credential data type, the system still passes the full credential to the child (not just the selected single attribute). Passing the full credential ensures the child authenticates correctly. Mapping a credential to a non-credential parameter: Mapping a credential to a child parameter that does not use a credential type triggers a warning upon selecting OK: - Select No to return and fix the mapping. - Select Yes to proceed. The system sends the credential to the child as a JSON value. |
| 5 | Description | Displays the use of the parameter, which will help you make informed mapping decisions. Note: The field is Read-only and will be populated when you click Get Parameters to fetch all parameters associated with the child workflows or process. |
| 6 | Get Parameters | Get the existing parameters associated with the workflows or process. |